Download OpenAPI specification:
REST API for CZERTAINLY Core
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "functionGroups": [
- {
- "functionGroupCode": "credentialProvider",
- "kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
- "endPoints": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "context": "/v1",
- "method": "POST",
- "required": "true"
}
], - "uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
- "name": "string"
}
], - "authType": "none",
- "authAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "waitingForApproval",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| uuid required | string Connector UUID |
| url | string URL of the Connector to connect |
| authType | string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector |
Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "authType": "none",
- "authAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "functionGroups": [
- {
- "functionGroupCode": "credentialProvider",
- "kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
- "endPoints": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "context": "/v1",
- "method": "POST",
- "required": "true"
}
], - "uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
- "name": "string"
}
], - "authType": "none",
- "authAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "waitingForApproval",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}[- {
- "functionGroup": {
- "functionGroupCode": "credentialProvider",
- "kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
- "endPoints": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "context": "/v1",
- "method": "POST",
- "required": "true"
}
], - "uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
- "name": "string"
}
}
]Connector UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| url required | string URL of the Connector to connect |
| uuid | string UUID of the Connector. Mandatory if connection is needed for the same Connector |
| authType required | string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector |
Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE |
{- "uuid": "string",
- "authType": "none",
- "authAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}[- {
- "functionGroup": {
- "functionGroupCode": "credentialProvider",
- "kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
- "endPoints": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "context": "/v1",
- "method": "POST",
- "required": "true"
}
], - "uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
- "name": "string"
}
}
]Connector UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| functionGroup | string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "cryptographyProvider" "notificationProvider" |
| kind | string |
| status | string (ConnectorStatus) Enum: "waitingForApproval" "connected" "failed" "offline" |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "functionGroups": [
- {
- "functionGroupCode": "credentialProvider",
- "kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
- "endPoints": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "context": "/v1",
- "method": "POST",
- "required": "true"
}
], - "uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
- "name": "string"
}
], - "authType": "none",
- "authAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "waitingForApproval",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
]| name required | string Name of the Connector |
| url required | string URL of the Connector to connect |
| authType required | string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector |
Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "Connector1",
- "authType": "none",
- "authAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "string"
}Connector UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]| uuid required | string Connector UUID |
| functionGroup required | string Function Group name |
| kind required | string Kind |
| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}{- "property1": {
- "property1": [
- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
], - "property2": [
- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]
}, - "property2": {
- "property1": [
- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
], - "property2": [
- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]
}
}| uuid required | string Connector UUID |
| functionGroup required | string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "cryptographyProvider" "notificationProvider" Function Group name |
| kind required | string Kind |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]Connector UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| userUuid required | string User UUID |
| description | string Description of the user |
| firstName | string First name of the user |
| lastName | string Last name of the user |
| email required | string Email of the user |
| groupUuids | Array of strings Groups UUIDs of the user (set to empty list to remove certificate from all groups) |
| certificateData | string Base64 Content of the admin certificate |
| certificateUuid | string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "description": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "groupUuids": [
- "string"
], - "certificateData": "string",
- "certificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| userUuid required | string User UUID |
| roleUuid required | string Role UUID |
{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| userUuid required | string User UUID |
| roleUuid required | string Role UUID |
{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}[- {
- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true
}
]| username required | string Username of the user |
| description | string Description of the user |
| firstName | string First name of the user |
| lastName | string Last name of the user |
string Email of the user | |
| groupUuids | Array of strings Groups UUIDs of the user |
| enabled | boolean Status of the user. True = Enabled, False = Disabled |
| certificateData | string Base64 Content of the user certificate |
| certificateUuid | string UUID of the existing certificate in the Inventory |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| name | string |
{- "username": "user1",
- "description": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "groupUuids": [
- "string"
], - "enabled": true,
- "certificateData": "string",
- "certificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "name": "string"
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| certificateContent | string Base64 Content of the certificate |
| authenticationToken | string Authentication Token |
{- "certificateContent": "string",
- "authenticationToken": "string"
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| userUuid required | string User UUID |
Role UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "allowAllResources": true,
- "resources": [
- {
- "name": "string",
- "allowAllActions": true,
- "actions": [
- "string"
], - "objects": [
- {
- "uuid": "string",
- "name": "string",
- "allow": [
- "string"
], - "deny": [
- "string"
]
}
]
}
]
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| description | string Description of the user |
| firstName | string First name of the user |
| lastName | string Last name of the user |
| email required | string Email of the user |
| groupUuids | Array of strings Groups UUIDs of the user (set to empty list to remove certificate from all groups) |
| certificateData | string Base64 Content of the admin certificate |
| certificateUuid | string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "description": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "groupUuids": [
- "string"
], - "certificateData": "string",
- "certificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "NONE",
- "displayName": "string",
- "listObjectsEndpoint": "string",
- "objectAccess": true,
- "actions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "displayName": "string"
}
]
}
]| resourceName required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource Name |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "jobName": "string",
- "jobType": "string",
- "cronExpression": "string",
- "enabled": true,
- "oneTime": true,
- "system": true,
- "lastExecutionStatus": "started",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "objectData": { }
}| uuid required | string Scheduled job UUID |
| cronExpression | string Cron expression for job schedule |
{- "cronExpression": "string"
}{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "jobName": "string",
- "jobType": "string",
- "cronExpression": "string",
- "enabled": true,
- "oneTime": true,
- "system": true,
- "lastExecutionStatus": "started",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "objectData": { }
}{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "scheduledJobs": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "jobName": "string",
- "jobType": "string",
- "cronExpression": "string",
- "enabled": true,
- "oneTime": true,
- "system": true,
- "lastExecutionStatus": "started"
}
]
}| uuid required | string Scheduled job UUID |
required | object (PaginationRequestDto) |
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "scheduledJobHistory": [
- {
- "jobUuid": "f6cd1d43-0519-40a4-895b-ab314e905ac3",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "status": "started",
- "resultMessage": "string",
- "resultObjectType": "NONE",
- "resultObjectIdentification": [
- "string"
]
}
]
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
Array of objects (RequestAttributeDto) List of attributes to create CSR. Required if CSR is not provided | |
Array of objects (RequestAttributeDto) List of attributes to sign the CSR | |
| request required | string Certificate signing request encoded as Base64 string |
| format | string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format |
| tokenProfileUuid | string <uuid> Token Profile UUID. Required if CSR is not uploaded |
| keyUuid | string <uuid> Key UUID. Required if CSR is not uploaded |
required | Array of objects (RequestAttributeDto) List of RA Profile related Attributes to issue Certificate |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "request": "string",
- "format": "pkcs10",
- "tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
- "keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "certificateData": "string",
- "uuid": "string"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| certificateUuid required | string Certificate UUID |
| reason | string (CertificateRevocationReason) Default: "UNSPECIFIED" Enum: "unspecified" "keyCompromise" "cACompromise" "affiliationChanged" "superseded" "cessationOfOperation" "certificateHold" "privilegeWithdrawn" "aACompromise" Reason for revocation |
required | Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate |
| destroyKey | boolean Default: "false" Destroy Key upon successful revocation |
{- "reason": "unspecified",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "destroyKey": "false"
}{- "message": "Error message"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| certificateUuid required | string Certificate UUID |
| replaceInLocations | boolean Default: "false" True to replace renewed certificate in the associated locations |
| request | string Certificate signing request encoded as Base64 string. If not provided, Existing CSR will be used |
| format | string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format |
{- "replaceInLocations": "false",
- "request": "string",
- "format": "pkcs10"
}{- "certificateData": "string",
- "uuid": "string"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| certificateUuid required | string Certificate UUID |
| replaceInLocations | boolean Default: "false" True to replace renewed certificate in the associated locations |
| request | string Certificate signing request encoded as Base64 string. If not provided, CSR attributes will be used |
| format | string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format |
| keyUuid required | string <uuid> Key UUID |
| tokenProfileUuid required | string <uuid> Token Profile UUID |
Array of objects (RequestAttributeDto) Signature Attributes. If not provided, existing attributes will be used to generate the new CSR |
{- "replaceInLocations": "false",
- "request": "string",
- "format": "pkcs10",
- "keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
- "tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
- "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "certificateData": "string",
- "uuid": "string"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| certificateUuid required | string Certificate UUID |
{- "certificateData": "string",
- "uuid": "string"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "type": "data",
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes"
}| uuid required | string Global Metadata UUID |
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: "true" Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
{- "description": "string",
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes"
}{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "type": "data",
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes"
}| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Attribute Content Type |
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: "true" Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
{- "name": "string",
- "contentType": "string",
- "description": "string",
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes"
}{- "uuid": "string"
}Global Metadata UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| uuid required | string Metadata UUID |
| connectorUuid required | string Connector UUID |
{- "uuid": "string",
- "connectorUuid": "string"
}{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "type": "data",
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes"
}{- "totalCertificates": 0,
- "totalGroups": 0,
- "totalDiscoveries": 0,
- "totalConnectors": 0,
- "totalRaProfiles": 0,
- "totalCredentials": 0,
- "totalAuthorities": 0,
- "totalAdministrators": 0,
- "totalClients": 0,
- "groupStatByCertificateCount": {
- "property1": 0,
- "property2": 0
}, - "raProfileStatByCertificateCount": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByType": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByExpiry": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByKeySize": {
- "property1": 0,
- "property2": 0
}, - "certificateStatBySubjectType": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByState": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByValidationStatus": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByComplianceStatus": {
- "property1": 0,
- "property2": 0
}, - "connectorStatByStatus": {
- "property1": 0,
- "property2": 0
}, - "raProfileStatByStatus": {
- "property1": 0,
- "property2": 0
}, - "administratorStatByStatus": {
- "property1": 0,
- "property2": 0
}, - "clientStatByStatus": {
- "property1": 0,
- "property2": 0
}
}| username required | string Username of the user |
| description | string Description of the user |
| firstName | string First name of the user |
| lastName | string Last name of the user |
string Email of the user | |
| groupUuids | Array of strings Groups UUIDs of the user |
| enabled | boolean Status of the user. True = Enabled, False = Disabled |
| certificateData | string Base64 Content of the user certificate |
| certificateUuid | string UUID of the existing certificate in the Inventory |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| name | string |
{- "username": "user1",
- "description": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "groupUuids": [
- "string"
], - "enabled": true,
- "certificateData": "string",
- "certificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "name": "string"
}{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "kind": "SoftKeyStore, Basic, ApiKey, etc",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "connectorUuid": "string",
- "connectorName": "string"
}| uuid required | string Credential UUID |
required | Array of objects (RequestAttributeDto) List of Credential Attributes |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "kind": "SoftKeyStore, Basic, ApiKey, etc",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "connectorUuid": "string",
- "connectorName": "string"
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "kind": "SoftKeyStore, Basic, ApiKey, etc",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "connectorUuid": "string",
- "connectorName": "string"
}
]| name required | string Credential name |
| kind required | string Credential Kind |
required | Array of objects (RequestAttributeDto) List of Credential Attributes |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| connectorUuid required | string UUID of Credential provider Connector |
{- "name": "string",
- "kind": "SoftKeyStore, Basic, ApiKey, etc",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "connectorUuid": "string"
}{- "uuid": "string"
}Credential UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE",
- "rules": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "conditions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}
]
}
], - "actions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "executions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
]
}
]
}| triggerUuid required | string Trigger UUID |
| description | string Description of the trigger |
| type required | string (TriggerType) Enum: "event" "manual" Type of the trigger |
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the trigger |
| ignoreTrigger required | boolean Flag if to ignore object when trigger rules are matched and do not perform any actions and stop evaluating other triggers. Based on context could have other implications to object processing. If ignore is set, trigger does not have any actions. |
| event | string Value: "discoveryFinished" Event of the trigger |
| eventResource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Type of the the trigger event source object |
| rulesUuids | Array of strings List of UUIDs of existing rules to add to the trigger |
| actionsUuids | Array of strings List of UUIDs of existing actions to add to the trigger |
{- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE",
- "rulesUuids": [
- "string"
], - "actionsUuids": [
- "string"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE",
- "rules": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "conditions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}
]
}
], - "actions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "executions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
]
}
]
}| resource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" |
| eventResource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE"
}
]| name required | string Name of the trigger |
| description | string Description of the trigger |
| type required | string (TriggerType) Enum: "event" "manual" Type of the trigger |
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the trigger |
| ignoreTrigger required | boolean Flag if to ignore object when trigger rules are matched and do not perform any actions and stop evaluating other triggers. Based on context could have other implications to object processing. If ignore is set, trigger does not have any actions. |
| event | string Value: "discoveryFinished" Event that should fire trigger |
| eventResource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Type of the the trigger event source object |
| rulesUuids | Array of strings List of UUIDs of existing rules to add to the trigger |
| actionsUuids | Array of strings List of UUIDs of existing actions to add to the trigger |
{- "name": "string",
- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE",
- "rulesUuids": [
- "string"
], - "actionsUuids": [
- "string"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE",
- "rules": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "conditions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}
]
}
], - "actions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "executions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
]
}
]
}| triggerUuid required | string Trigger UUID |
| associationObjectUuid required | string Trigger Association Object UUID |
[- {
- "uuid": "string",
- "triggerUuid": "string",
- "objectUuid": "string",
- "referenceObjectUuid": "string",
- "conditionsMatched": true,
- "actionsPerformed": true,
- "triggeredAt": "2019-08-24T14:15:22Z",
- "message": "string",
- "records": [
- {
- "message": "string",
- "condition": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}, - "execution": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
}
]
}
]| associationObjectUuid required | string Trigger Association Object UUID |
{- "associationResource": "NONE",
- "associationObjectUuid": "string",
- "objectsResource": "NONE",
- "objectsEvaluated": 0,
- "objectsMatched": 0,
- "objectsIgnored": 0,
- "objects": [
- {
- "objectUuid": "099486af-28ad-4686-8639-67f5d62fa89c",
- "referenceObjectUuid": "7a517f58-be85-4019-b82a-683e436bf748",
- "matched": true,
- "ignored": true,
- "triggers": [
- {
- "triggerUuid": "ca4fb7a3-f773-4484-9f51-9819f1ae7343",
- "triggerName": "string",
- "triggeredAt": "2019-08-24T14:15:22Z",
- "message": "string",
- "records": [
- {
- "message": "string",
- "condition": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": null,
- "fieldIdentifier": null,
- "operator": null,
- "value": { }
}
]
}, - "execution": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": null,
- "fieldIdentifier": null,
- "data": { }
}
]
}
}
]
}
]
}
]
}API to trigger the Callback for resource.
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Name of the resource |
| parentObjectUuid required | string Parent Object UUID |
| uuid | string UUID of the Attribute |
| name required | string Name of the Attribute |
object Map of path variables supported by the callback method | |
object Map of the query parameters supported by the callback method | |
object Request body for the callback method |
{- "uuid": "string",
- "name": "string",
- "pathVariable": {
- "property1": { },
- "property2": { }
}, - "requestParameter": {
- "property1": { },
- "property2": { }
}, - "body": {
- "property1": { },
- "property2": { }
}
}{ }API to trigger the Callback for Connector.
| uuid required | string Connector UUID |
| functionGroup required | string Function Group |
| kind required | string Kind |
| uuid | string UUID of the Attribute |
| name required | string Name of the Attribute |
object Map of path variables supported by the callback method | |
object Map of the query parameters supported by the callback method | |
object Request body for the callback method |
{- "uuid": "string",
- "name": "string",
- "pathVariable": {
- "property1": { },
- "property2": { }
}, - "requestParameter": {
- "property1": { },
- "property2": { }
}, - "body": {
- "property1": { },
- "property2": { }
}
}{ }External Notification Management API for managing notification instances that can be used to notify recipient(s) about events that were triggered in the platform. Note that this API does not handle internal notifications. For internal notifications, please refer to the Internal Notification API
| uuid required | string Notification instance UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}| uuid required | string Notification instance UUID |
| description | string Notification instance description |
required | Array of objects (RequestAttributeDto) List of Notification instance Attributes |
Array of objects (AttributeMappingDto) List of attribute mappings between mapping attributes and (recipient) custom attributes |
{- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}
]| description | string Notification instance description |
required | Array of objects (RequestAttributeDto) List of Notification instance Attributes |
Array of objects (AttributeMappingDto) List of attribute mappings between mapping attributes and (recipient) custom attributes | |
| name required | string Notification instance name |
| connectorUuid required | string UUID of Notification provider |
| kind required | string Notification instance Kind |
{- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
], - "name": "string",
- "connectorUuid": "string",
- "kind": "string"
}{- "uuid": "string"
}| connectorUuid required | string Connector UUID |
| kind required | string Kind |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
| description | string Description of the Location |
required | Array of objects (RequestAttributeDto) List of Attributes for Location |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| enabled | boolean Enabled flag - true = enabled; false = disabled |
{- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
| certificateUuid required | string Certificate UUID |
required | Array of objects (RequestAttributeDto) List of push Attributes for Location |
{- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
| certificateUuid required | string Certificate UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
| certificateUuid required | string Certificate UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}{- "locations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
], - "sourceObjects": [
- null
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}| entityUuid required | string Entity UUID |
| name required | string Location name |
| description | string Location description |
required | Array of objects (RequestAttributeDto) List of Attributes to register Location |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| enabled | boolean Default: "false" Enabled flag - true = enabled; false = disabled |
{- "name": "string",
- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": "false"
}{- "uuid": "string"
}| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
| raProfileUuid required | string RA Profile UUID |
required | Array of objects (RequestAttributeDto) List of CSR Attributes for Location |
required | Array of objects (RequestAttributeDto) List of certificate issue Attributes for RA Profile |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
Array of objects (RequestAttributeDto) List of Certificate Custom Attributes |
{- "raProfileUuid": "string",
- "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "issueAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "certificateCustomAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| entityUuid required | string Entity UUID |
| locationUuid required | string Location UUID |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "Keystore, etc."
}| entityUuid required | string Entity instance UUID |
required | Array of objects (RequestAttributeDto) List of Entity instance Attributes |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "Keystore, etc."
}| name required | string Entity instance name |
required | Array of objects (RequestAttributeDto) List of Entity instance Attributes |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| connectorUuid required | string UUID of Entity Provider |
| kind required | string Entity instance Kind |
{- "name": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "connectorUuid": "string",
- "kind": "Keystore, etc."
}{- "uuid": "string"
}| entityUuid required | string Entity instance UUID |
| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
][ "Error Message 1", "Error Message 2" ]
Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}{- "entities": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "Keystore, etc."
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
][- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]| uuid required | string Authority instance UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "LegacyEjbca, ADCS, etc."
}| uuid required | string Authority instance UUID |
required | Array of objects (RequestAttributeDto) List of Authority instance Attributes |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "LegacyEjbca, ADCS, etc."
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "LegacyEjbca, ADCS, etc."
}
]| name required | string Authority instance name |
required | Array of objects (RequestAttributeDto) List of Authority instance Attributes |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| connectorUuid required | string UUID of Authority provider |
| kind required | string Authority instance Kind |
{- "name": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "connectorUuid": "string",
- "kind": "LegacyEjbca, ADCS, etc"
}{- "uuid": "string"
}Authority Instance UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]| uuid required | string Authority instance UUID |
| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
][- "string"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "authorityInstanceUuid": "string",
- "authorityInstanceName": "string",
- "legacyAuthority": true,
- "enabled": true,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabledProtocols": [
- "string"
], - "certificateValidationSettings": {
- "enabled": true,
- "frequency": 1,
- "expiringThreshold": 1
}
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| description | string Description of RA Profile |
required | Array of objects (RequestAttributeDto) List of Attributes for RA Profile |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| enabled | boolean Enabled flag - true = enabled; false = disabled |
{- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "authorityInstanceUuid": "string",
- "authorityInstanceName": "string",
- "legacyAuthority": true,
- "enabled": true,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabledProtocols": [
- "string"
], - "certificateValidationSettings": {
- "enabled": true,
- "frequency": 1,
- "expiringThreshold": 1
}
}RA Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| authorityUuid required | string Authority Instance UUID |
| name required | string RA Profile name |
| description | string RA Profile description |
required | Array of objects (RequestAttributeDto) List of Attributes to create RA Profile |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| enabled | boolean Default: "false" Enabled flag - true = enabled; false = disabled |
{- "name": "string",
- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": "false"
}{- "uuid": "string"
}RA Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}RA Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| enabled | boolean Indicator whether validation of certificates associated with RA profile should be enabled, if null, then values in platform settings will be used |
| frequency | integer <int32> >= 1 Default: "1" Frequency of validation of certificates in days, when not set, value in platform settings is used |
| expiringThreshold | integer <int32> >= 1 Default: "30" How many days before expiration should certificate validation status change to Expiring, when not set, value in platform settings is used |
{- "enabled": true,
- "frequency": "1",
- "expiringThreshold": "30"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "authorityInstanceUuid": "string",
- "authorityInstanceName": "string",
- "legacyAuthority": true,
- "enabled": true,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabledProtocols": [
- "string"
], - "certificateValidationSettings": {
- "enabled": true,
- "frequency": 1,
- "expiringThreshold": 1
}
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| scepProfileUuid required | string SCEP Profile UUID |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
{- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "scepAvailable": true,
- "url": "string",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| cmpProfileUuid required | string CMP Profile UUID |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
required | Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate |
{- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "cmpAvailable": true,
- "cmpUrl": "string",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
| acmeProfileUuid required | string ACME Profile UUID |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
required | Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate |
{- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "acmeAvailable": true,
- "directoryUrl": "string",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| authorityUuid required | string Authority instance UUID |
| raProfileUuid required | string RA profile UUID |
| approvalProfileUuid required | string Approval profile UUID |
{- "message": "Error message"
}| authorityUuid required | string Authority instance UUID |
| raProfileUuid required | string RA profile UUID |
| approvalProfileUuid required | string Approval profile UUID |
{- "message": "Error message"
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "authorityInstanceUuid": "string",
- "authorityInstanceName": "string",
- "legacyAuthority": true,
- "enabled": true,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabledProtocols": [
- "string"
], - "certificateValidationSettings": {
- "enabled": true,
- "frequency": 1,
- "expiringThreshold": 1
}
}
]RA Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| raProfileUuid required | string RA Profile UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "authorityInstanceUuid": "string",
- "authorityInstanceName": "string",
- "legacyAuthority": true,
- "enabled": true,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabledProtocols": [
- "string"
], - "certificateValidationSettings": {
- "enabled": true,
- "frequency": 1,
- "expiringThreshold": 1
}
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "scepAvailable": true,
- "url": "string",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "cmpAvailable": true,
- "cmpUrl": "string",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "acmeAvailable": true,
- "directoryUrl": "string",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| authorityUuid required | string Authority UUID |
| raProfileUuid required | string RA Profile UUID |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string"
}
]| authorityUuid required | string Authority instance UUID |
| raProfileUuid required | string RA profile UUID |
[- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true,
- "extendedKeyUsage": [
- "string"
], - "keyUsage": [
- "string"
], - "subjectType": "endEntity",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "certificateContent": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "locations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": null,
- "name": null,
- "label": null,
- "type": null,
- "contentType": null,
- "content": [ ],
- "sourceObjects": [ ]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
], - "sourceObjects": [
- {
- "uuid": null,
- "name": null
}
]
}
]
}
]
}
], - "nonCompliantRules": [
- {
- "connectorName": "Provider1",
- "ruleName": "RuleName",
- "ruleDescription": "Description sample",
- "status": "ok",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "key": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
]
}
]
}
], - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "associations": 0
}, - "certificateRequest": {
- "certificateType": "X.509",
- "certificateRequestFormat": "pkcs10",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "content": "string",
- "commonName": "string",
- "subjectDn": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "keyUuid": "string"
}, - "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
- "issueAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "relatedCertificates": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
], - "protocolInfo": {
- "protocol": "acme",
- "protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
- "additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}
]| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| authorityUuid required | string Authority Instance UUID |
| raProfileUuid required | string RA Profile UUID |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| authorityUuid required | string Authority instance UUID |
| raProfileUuid required | string RA profile UUID |
[- {
- "uuid": "string",
- "name": "ApprovalProfile1",
- "version": "1",
- "description": "Detail description of the approval profile",
- "enabled": "true",
- "expiry": "30",
- "numberOfSteps": "2",
- "associations": 0
}
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "variant": "v2",
- "description": "Sample text description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "requestProtectionMethod": "sharedSecret",
- "responseProtectionMethod": "sharedSecret",
- "signingCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
}| cmpProfileUuid required | string CMP Profile UUID |
| description | string Description of the CMP Profile |
| raProfileUuid | string RA Profile UUID that the CMP Profile is associated with |
Array of objects (RequestAttributeDto) List of Attributes to issue Certificate for the associated RA Profile. Required when raProfileUuid is provided | |
Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate for the associated RA Profile. Required when raProfileUuid is provided | |
Array of objects (RequestAttributeDto) List of Custom Attributes for CMP Profile | |
| requestProtectionMethod required | string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Request |
| responseProtectionMethod required | string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response |
| sharedSecret | string Shared secret for the CMP Request. Required when requestProtectionMethod is sharedSecret |
| signingCertificateUuid | string UUID of the Certificate to be used as signing certificate for CMP responses. Required when responseProtectionMethod is signature |
| name required | string Name of the CMP Profile |
| variant required | string Enum: "v2" "v2_3gpp" "v3" Variant of the CMP Profile |
{- "description": "Sample text description",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "requestProtectionMethod": "sharedSecret",
- "responseProtectionMethod": "sharedSecret",
- "sharedSecret": "string",
- "signingCertificateUuid": "string",
- "name": "Example CMP Profile",
- "variant": "v2"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "variant": "v2",
- "description": "Sample text description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "requestProtectionMethod": "sharedSecret",
- "responseProtectionMethod": "sharedSecret",
- "signingCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "variant": "v2",
- "description": "Sample text description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
},
}
]| description | string Description of the CMP Profile |
| raProfileUuid | string RA Profile UUID that the CMP Profile is associated with |
Array of objects (RequestAttributeDto) List of Attributes to issue Certificate for the associated RA Profile. Required when raProfileUuid is provided | |
Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate for the associated RA Profile. Required when raProfileUuid is provided | |
Array of objects (RequestAttributeDto) List of Custom Attributes for CMP Profile | |
| requestProtectionMethod required | string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Request |
| responseProtectionMethod required | string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response |
| sharedSecret | string Shared secret for the CMP Request. Required when requestProtectionMethod is sharedSecret |
| signingCertificateUuid | string UUID of the Certificate to be used as signing certificate for CMP responses. Required when responseProtectionMethod is signature |
| name required | string Name of the CMP Profile |
| variant required | string Enum: "v2" "v2_3gpp" "v3" Variant of the CMP Profile |
{- "description": "Sample text description",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "requestProtectionMethod": "sharedSecret",
- "responseProtectionMethod": "sharedSecret",
- "sharedSecret": "string",
- "signingCertificateUuid": "string",
- "name": "Example CMP Profile",
- "variant": "v2"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "variant": "v2",
- "description": "Sample text description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "requestProtectionMethod": "sharedSecret",
- "responseProtectionMethod": "sharedSecret",
- "signingCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
}CMP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}CMP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}[- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
]CMP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]CMP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]| name required | string Discovery name |
required | Array of objects (RequestAttributeDto) List of Attributes for Discovery |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| connectorUuid required | string Discovery Provider UUID |
| kind required | string Discovery Kind |
| triggers | Array of strings <uuid> [ items <uuid > ] List of triggers to be triggered after the discovery is finished, triggers will be evaluated in given order |
{- "name": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "connectorUuid": "string",
- "kind": "string",
- "triggers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "uuid": "string"
}Discovery UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| jobName | string |
| cronExpression | string |
| oneTime | boolean |
object (DiscoveryDto) |
{- "jobName": "string",
- "cronExpression": "string",
- "oneTime": true,
- "request": {
- "name": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "connectorUuid": "string",
- "kind": "string",
- "triggers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}{- "uuid": "string"
}Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}{- "discoveries": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "kind": "IP-HostName",
- "status": "inProgress",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "totalCertificatesDiscovered": "0",
- "connectorUuid": "string",
- "connectorName": "string"
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "kind": "IP-HostName",
- "status": "inProgress",
- "connectorStatus": "inProgress",
- "message": "Failed due to network connectivity issues",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "totalCertificatesDiscovered": "0",
- "connectorTotalCertificatesDiscovered": "0",
- "connectorUuid": "string",
- "connectorName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "triggers": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE"
}
]
}| uuid required | string Discovery UUID |
| newlyDiscovered | boolean |
| itemsPerPage | integer <int32> Default: 10 |
| pageNumber | integer <int32> Default: 0 |
{- "certificates": [
- {
- "uuid": "string",
- "inventoryUuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "fingerprint": "string",
- "certificateContent": "string",
- "newlyDiscovered": true,
- "processed": true,
- "processedError": "string"
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "dnsResolverIp": "8.8.8.8",
- "dnsResolverPort": "53",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "retryInterval": "30",
- "termsOfServiceChangeDisable": "false",
- "validity": "36000",
- "requireContact": "true",
- "requireTermsOfService": "true",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| uuid required | string ACME Profile UUID |
| description | string Description of the ACME Profile |
| termsOfServiceUrl | string Terms of Service URL |
| websiteUrl | string Website URL |
| dnsResolverIp | string Default: "System Default" DNS Resolver IP address |
| dnsResolverPort | string Default: "53" DNS Resolver port number |
| raProfileUuid | string RA Profile UUID |
| retryInterval | integer <int32> Default: "30" Retry interval for the Orders |
| termsOfServiceChangeDisable | boolean Default: "false" Disable new Orders due to change in Terms of Service |
| termsOfServiceChangeUrl | string Changes of Terms of Service URL |
| validity | integer <int32> Default: "36000" Order Validity |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
required | Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate |
| requireContact | boolean Default: "false" Require contact information for new Account |
| requireTermsOfService | boolean Default: "false" Require new Account to agree on Terms of Service |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "description": "Sample description",
- "dnsResolverIp": "8.8.8.8",
- "dnsResolverPort": "53",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "retryInterval": "60",
- "termsOfServiceChangeDisable": "false",
- "validity": "3000",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "requireContact": "true",
- "requireTermsOfService": "false",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "dnsResolverIp": "8.8.8.8",
- "dnsResolverPort": "53",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "retryInterval": "30",
- "termsOfServiceChangeDisable": "false",
- "validity": "36000",
- "requireContact": "true",
- "requireTermsOfService": "true",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": "false",
- "description": "Some description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
},
}
]| name required | string Name of the ACME Profile |
| description | string Description of the ACME Profile |
| termsOfServiceUrl | string Terms of Service URL |
| websiteUrl | string Website URL |
| dnsResolverIp | string Default: "System Default" DNS Resolver IP address |
| dnsResolverPort | string Default: "53" DNS Resolver port number |
| raProfileUuid | string RA Profile UUID |
| retryInterval | integer <int32> Default: "30" Retry interval for the Orders |
| validity | integer <int32> Default: "36000" Order Validity |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
required | Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate |
| requireContact | boolean Default: "false" Require contact information for new Account |
| requireTermsOfService | boolean Default: "false" Require new Account to agree on Terms of Service |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "Profile Name 1",
- "description": "Sample description",
- "dnsResolverIp": "8.8.8.8",
- "dnsResolverPort": "53",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "retryInterval": "60",
- "validity": "3000",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "requireContact": "true",
- "requireTermsOfService": "false",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "string"
}ACME Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}ACME Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}ACME Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]ACME Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]| uuid required | string Approval profile UUID |
required | object (ApprovalProfileForVersionDto) Select specific version of the approval profile |
{- "uuid": "string",
- "name": "ApprovalProfile1",
- "version": "1",
- "description": "Detail description of the approval profile",
- "enabled": "true",
- "expiry": "30",
- "numberOfSteps": "2",
- "associations": 0,
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "username": "string",
- "roleName": "string",
- "groupName": "string"
}
]
}| uuid required | string Approval profile UUID |
| description | string Description of the Approval profile |
| expiry | integer <int32> Expiration of the Approval profile in hours |
required | Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile |
{- "description": "Detail description of the approval profile",
- "expiry": "30",
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0
}
]
}{ }{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "approvalProfiles": [
- {
- "uuid": "string",
- "name": "ApprovalProfile1",
- "version": "1",
- "description": "Detail description of the approval profile",
- "enabled": "true",
- "expiry": "30",
- "numberOfSteps": "2",
- "associations": 0
}
]
}| name required | string Name of the Approval profile |
| description | string Description of the Approval profile |
| enabled required | boolean Enable of the Approval profile |
| expiry | integer <int32> Expiration of the Approval profile in hours |
required | Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile |
{- "name": "ApprovalProfile1",
- "description": "Detail description of the approval profile",
- "enabled": "true",
- "expiry": "30",
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0
}
]
}{- "uuid": "string"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}| executionUuid required | string Execution UUID |
| description | string Description of the execution |
required | Array of objects (ExecutionItemRequestDto) List of the execution items to add to execution |
{- "description": "string",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "executions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
]
}| actionUuid required | string Action UUID |
| description | string Description of the action |
| executionsUuids required | Array of strings List of UUIDs of existing executions to add to the action |
{- "description": "string",
- "executionsUuids": [
- "string"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "executions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
]
}| resource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
]| name required | string Name of the execution |
| description | string Description of the execution |
| type required | string (ExecutionType) Value: "setField" Type of the execution |
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the execution |
required | Array of objects (ExecutionItemRequestDto) List of the execution items to add to execution |
{- "name": "string",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}| resource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE"
}
]| name required | string Name of the action |
| description | string Description of the action |
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the action |
| executionsUuids required | Array of strings List of UUIDs of existing executions to add to the action |
{- "name": "string",
- "description": "string",
- "resource": "NONE",
- "executionsUuids": [
- "string"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "executions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "setField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "data": { }
}
]
}
]
}{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "type": "data",
- "label": "Attribute Name",
- "required": true,
- "visible": "true",
- "group": "requiredAttributes",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "resources": [
- "NONE"
]
}| uuid required | string Attribute UUID |
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: "true" Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
| required | boolean Default: "false" Boolean determining if the Attribute is required. If true, the Attribute must be provided. |
| readOnly | boolean Default: "false" Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed. |
| list | boolean Default: "false" Boolean determining if the Attribute contains list of values in the content |
| multiSelect | boolean Default: "false" Boolean determining if the Attribute can have multiple values |
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type | |
| resources | Array of strings (Resource) Items Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" List of resource to be associated with the custom attribute |
{- "description": "string",
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "resources": [
- "NONE"
]
}{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "type": "data",
- "label": "Attribute Name",
- "required": true,
- "visible": "true",
- "group": "requiredAttributes",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "resources": [
- "NONE"
]
}| attributeContentType | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" |
[- {
- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "resources": [
- "NONE"
]
}
]| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Attribute Content Type |
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: "true" Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
| required | boolean Default: "false" Boolean determining if the Attribute is required. If true, the Attribute must be provided. |
| readOnly | boolean Default: "false" Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed. |
| list | boolean Default: "false" Boolean determining if the Attribute contains list of values in the content |
| multiSelect | boolean Default: "false" Boolean determining if the Attribute can have multiple values |
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type | |
| resources | Array of strings (Resource) Items Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" List of resource to be associated with the custom attribute |
{- "name": "string",
- "contentType": "string",
- "description": "string",
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "resources": [
- "NONE"
]
}{- "uuid": "string"
}Attribute UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| uuid required | string <uuid> Custom Attribute UUID |
List of Resources
[- "raProfiles",
- "authorities"
]{- "message": "Error message"
}| resourceName required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource Type |
| objectUuid required | string Object UUID |
| attributeUuid required | string Custom Attribute UUID |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]| resourceName required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource Type |
| objectUuid required | string Object UUID |
| attributeUuid required | string Custom Attribute UUID |
| reference | string Content Reference |
| data required | boolean Boolean attribute value |
[- {
- "reference": "string",
- "data": true
}
][- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]Attribute UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}Attribute UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource Name |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}
}
]Internal Notifications API that manages notifications for logged user in the platform. Note that this API does not manage nor trigger external notifications. For external notifications, please refer to the External Notification Management API.
required | object (NotificationRequestDto) Show only unread notifications |
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "items": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "message": "string",
- "detail": "string",
- "readAt": "2019-08-24T14:15:22Z",
- "sentAt": "2019-08-24T14:15:22Z",
- "targetObjectType": "NONE",
- "targetObjectIdentification": [
- "string"
]
}
]
}Notifications UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}Notifications UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Token Profile UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Token Profile UUID |
| description | string Description of Token Profile |
required | Array of objects (RequestAttributeDto) List of Attributes for Token Profile |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| enabled | boolean Enabled flag - true = enabled; false = disabled |
| usage | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
{- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "usage": [
- "sign"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
{- "usage": [
- "sign"
]
}{- "message": "Error message"
}| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
| uuids required | Array of strings <uuid> [ items <uuid > ] Token Profile UUIDs |
{- "usage": [
- "sign"
], - "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}| tokenInstanceUuid required | string Token Instance UUID |
| name required | string Token Profile name |
| description | string Token Profile description |
required | Array of objects (RequestAttributeDto) List of Attributes to create Token Profile |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| enabled | boolean Default: "false" Enabled flag - true = enabled; false = disabled |
| usage | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
{- "name": "string",
- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": "false",
- "usage": [
- "sign"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}Token Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}Token Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}
]Token Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}ACME Account UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| acmeProfileUuid required | string ACME Profile UUID |
| acmeAccountUuid required | string ACME Account UUID |
{- "accountId": "TtrgfYTR6F",
- "uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "enabled": "false",
- "totalOrders": "23",
- "successfulOrders": "2",
- "failedOrders": "239",
- "pendingOrders": "24",
- "validOrders": "23",
- "processingOrders": "27",
- "status": "valid",
- "contact": "mailto: someadmin@domain.com",
- "termsOfServiceAgreed": "true",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "acmeProfileName": "ACME Profile 1",
- "acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}ACME Account UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}ACME Account UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}[- {
- "accountId": "HJAT6gc7i6",
- "uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "enabled": "false",
- "totalOrders": "4",
- "status": "valid",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "acmeProfileName": "ACMEProfile1",
- "acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}
]Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "items": [
- {
- "id": 0,
- "version": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "module": "approvals",
- "actor": {
- "type": "anonymous",
- "authMethod": "none",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string"
}, - "source": {
- "method": "string",
- "path": "string",
- "contentType": "string",
- "ipAddress": "string",
- "userAgent": "string"
}, - "resource": {
- "type": "NONE",
- "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "names": [
- "string"
]
}, - "affiliatedResource": {
- "type": "NONE",
- "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "names": [
- "string"
]
}, - "operation": "unknown",
- "operationResult": "success",
- "message": "string",
- "operationData": { },
- "additionalData": {
- "property1": { },
- "property2": { }
}
}
]
}| fieldSource required | string (FilterFieldSource) Enum: "meta" "custom" "data" "property" Field group of search filter |
| fieldIdentifier required | string Field identifier of search filter. List of available fields with their identifiers can be retrieved from corresponding endpoint |
| condition required | string (FilterConditionOperator) Enum: "EQUALS" "NOT_EQUALS" "GREATER" "GREATER_OR_EQUAL" "LESSER" "LESSER_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" "STARTS_WITH" "ENDS_WITH" "EMPTY" "NOT_EMPTY" "SUCCESS" "FAILED" "UNKNOWN" "NOT_CHECKED" Condition for the search filter |
| value | object Value to match |
[- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]{- "message": "Error message"
}| fieldSource required | string (FilterFieldSource) Enum: "meta" "custom" "data" "property" Field group of search filter |
| fieldIdentifier required | string Field identifier of search filter. List of available fields with their identifiers can be retrieved from corresponding endpoint |
| condition required | string (FilterConditionOperator) Enum: "EQUALS" "NOT_EQUALS" "GREATER" "GREATER_OR_EQUAL" "LESSER" "LESSER_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" "STARTS_WITH" "ENDS_WITH" "EMPTY" "NOT_EMPTY" "SUCCESS" "FAILED" "UNKNOWN" "NOT_CHECKED" Condition for the search filter |
| value | object Value to match |
[- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]"string"[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| uuid required | string Group UUID |
| name required | string Name of the Group |
| description | string Description of the Group |
string Group contact email | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "string",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
]| name required | string Name of the Group |
| description | string Description of the Group |
string Group contact email | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "string",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "string"
}Group UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}{- "certificates": {
- "validation": {
- "enabled": true,
- "frequency": 1,
- "expiringThreshold": 1
}
}
}object (UtilsSettingsDto) Utils settings of the platform | |
object (CertificateSettingsUpdateDto) Settings applicable to all certificates in inventory by default |
{- "certificates": {
- "validation": {
- "enabled": "true",
- "frequency": "1",
- "expiringThreshold": "30"
}
}
}{- "message": "Error message"
}required | object Map of notification instances where key is notification type enum |
{- "notificationsMapping": {
- "property1": "string",
- "property2": "string"
}
}{- "message": "Error message"
}{- "auditLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
], - "output": "NONE"
}, - "eventLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
]
}
}required | object (AuditLoggingSettingsDto) Settings of audit logging |
required | object (ResourceLoggingSettingsDto) Settings of event logging |
{- "auditLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
], - "output": "NONE"
}, - "eventLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
]
}
}{- "message": "Error message"
}{- "disableLocalhostUser": true,
- "oauth2Providers": {
- "property1": {
- "name": "string",
- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m",
- "jwkSetKeys": [
- {
- "kid": "string",
- "publicKey": "string",
- "keyType": "string",
- "algorithm": "string",
- "use": "string"
}
]
}, - "property2": {
- "name": "string",
- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m",
- "jwkSetKeys": [
- {
- "kid": "string",
- "publicKey": "string",
- "keyType": "string",
- "algorithm": "string",
- "use": "string"
}
]
}
}
}| disableLocalhostUser required | boolean Disable using localhost user for requests from localhost |
Array of objects (OAuth2ProviderSettingsDto) |
{- "disableLocalhostUser": true,
- "oauth2Providers": [
- {
- "name": "string",
- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m",
- "jwkSetKeys": [
- {
- "kid": "string",
- "publicKey": "string",
- "keyType": "string",
- "algorithm": "string",
- "use": "string"
}
]
}
]
}{- "message": "Error message"
}| providerName required | string OAuth2 Provider Name |
{- "name": "string",
- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m",
- "jwkSetKeys": [
- {
- "kid": "string",
- "publicKey": "string",
- "keyType": "string",
- "algorithm": "string",
- "use": "string"
}
]
}| providerName required | string OAuth2 Provider Name |
| issuerUrl | string URL of issuer issuing authentication tokens. If provided, authentication via JWT token is enabled for this provider. |
| clientId | string The client ID used to identify the client application during the authorization process. |
| clientSecret | string The client secret used by the client application to authenticate with the authorization server. |
| authorizationUrl | string The URL where the authorization server redirects the user for login and authorization. |
| tokenUrl | string The URl used to exchange the authorization code or credentials for an access token. |
| jwkSetUrl | string The URL where the JSON Web Key Set (JWKS) containing the public keys used to verify JWT tokens can be retrieved. |
| jwkSet | string Base64 encoded JWK Set, provided in case JWK Set URL is not available |
| scope | Array of strings The list of scopes that define the access levels and permissions requested by the client application. |
| logoutUrl | string URL to end session on provider side. |
| postLogoutUrl | string URL that user will be redirected after logout from application. |
| userInfoUrl | string The URL containing information about user. |
| audiences | Array of strings A list of expected audiences for validating the issued tokens, used to match the intended recipients of the tokens. |
| skew | integer <int32> The allowed time skew, in seconds, for token validation. This accounts for clock differences between systems. Default value is 30 seconds. |
| sessionMaxInactiveInterval | integer <int32> Default: "15m" Duration in seconds after which will inactive user's session be terminated. |
{- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m"
}Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}{- "certificates": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body
| groupUuids | Array of strings Certificate Groups UUIDs (set to empty list to remove certificate from all groups) |
| ownerUuid | string Certificate owner user UUID (set to empty string to remove owner of certificate) |
| raProfileUuid | string RA Profile UUID (set to empty string to remove certificate from RA profile) |
| certificateUuids | Array of strings List of Certificate UUIDs |
Array of objects (SearchFilterRequestDto) Certificate filter input |
{- "groupUuids": [
- "string"
], - "ownerUuid": "string",
- "raProfileUuid": "string",
- "certificateUuids": [
- "string"
], - "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]
}{- "message": "Error message"
}| certificate required | string Base64 Content of the Certificate |
required | Array of objects (RequestAttributeDto) Custom Attributes for the Certificate |
{- "certificate": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "string"
}In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body
| uuids | Array of strings List of Certificate UUIDs |
Array of objects (SearchFilterRequestDto) Certificate filter input |
{- "uuids": [
- "string"
], - "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]
}{- "status": "SUCCESS",
- "failedItem": 0,
- "message": "string"
}| raProfileUuid required | string <uuid> RA Profile UUID. Required if CSR is not uploaded |
| sourceCertificateUuid | string <uuid> Source certificate UUID to specify in case of renew/rekey operation |
Array of objects (RequestAttributeDto) List of attributes to create CSR. Required if CSR is not provided | |
Array of objects (RequestAttributeDto) List of attributes to sign the CSR | |
| request | string Certificate signing request encoded as Base64 string |
| format | string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format |
| tokenProfileUuid | string <uuid> Token Profile UUID. Required if CSR is not uploaded |
| keyUuid | string <uuid> Key UUID. Required if CSR is not uploaded |
required | Array of objects (RequestAttributeDto) List of RA Profile related Attributes to issue Certificate |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "raProfileUuid": "b9278d9c-f0fb-4571-ad29-d552005d6e12",
- "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
- "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "request": "string",
- "format": "pkcs10",
- "tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
- "keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
- "issueAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true,
- "extendedKeyUsage": [
- "string"
], - "keyUsage": [
- "string"
], - "subjectType": "endEntity",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "certificateContent": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "locations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
], - "sourceObjects": [
- null
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}
], - "nonCompliantRules": [
- {
- "connectorName": "Provider1",
- "ruleName": "RuleName",
- "ruleDescription": "Description sample",
- "status": "ok",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "key": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
]
}
]
}
], - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "associations": 0
}, - "certificateRequest": {
- "certificateType": "X.509",
- "certificateRequestFormat": "pkcs10",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "content": "string",
- "commonName": "string",
- "subjectDn": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "keyUuid": "string"
}, - "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
- "issueAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "relatedCertificates": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
], - "protocolInfo": {
- "protocol": "acme",
- "protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
- "additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}Certificate UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "certificateContent": "string"
}
]| certificateUuids | Array of strings List of UUIDs of the Certificates |
{- "certificateUuids": [
- "string"
]
}{- "message": "Error message"
}{- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true,
- "extendedKeyUsage": [
- "string"
], - "keyUsage": [
- "string"
], - "subjectType": "endEntity",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "certificateContent": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "locations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
], - "sourceObjects": [
- null
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}
], - "nonCompliantRules": [
- {
- "connectorName": "Provider1",
- "ruleName": "RuleName",
- "ruleDescription": "Description sample",
- "status": "ok",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "key": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
]
}
]
}
], - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "associations": 0
}, - "certificateRequest": {
- "certificateType": "X.509",
- "certificateRequestFormat": "pkcs10",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "content": "string",
- "commonName": "string",
- "subjectDn": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "keyUuid": "string"
}, - "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
- "issueAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "relatedCertificates": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
], - "protocolInfo": {
- "protocol": "acme",
- "protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
- "additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}| uuid required | string Certificate UUID |
| groupUuids | Array of strings Certificate Groups UUIDs (set to empty list to remove certificate from all groups) |
| ownerUuid | string Certificate owner user UUID (set to empty string to remove owner of certificate) |
| raProfileUuid | string RA Profile UUID (set to empty string to remove certificate from RA profile) |
| trustedCa | boolean Mark CA certificate as trusted |
{- "groupUuids": [
- "string"
], - "ownerUuid": "string",
- "raProfileUuid": "string",
- "trustedCa": true
}{- "message": "Error message"
}| uuid required | string Certificate UUID |
| certificateFormat required | string (CertificateFormat) Enum: "raw" "pkcs7" Certificate format |
| encoding required | string (CertificateFormatEncoding) Enum: "pem" "der" |
{- "format": "raw",
- "encoding": "pem",
- "content": "string"
}{- "resultStatus": "not_checked",
- "validationChecks": {
- "property1": {
- "validationCheck": "certificate_chain",
- "status": "not_checked",
- "message": "string"
}, - "property2": {
- "validationCheck": "certificate_chain",
- "status": "not_checked",
- "message": "string"
}
}
}[- {
- "uuid": "string",
- "certificateUuid": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "event": "Issue Certificate",
- "status": "SUCCESS",
- "message": "string",
- "additionalInformation": {
- "property1": { },
- "property2": { }
}
}
]Get certificate chain for the certificate with the given UUID. The certificate chain is returned in the order of the chain, with the first certificate being the certificate with the given UUID, up to the last identified certificate in the chain. If the certificate with the given UUID has status NEW or REJECTED, an empty list is returned.
| uuid required | string Certificate UUID |
| withEndCertificate | boolean |
{- "completeChain": true,
- "certificates": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true,
- "extendedKeyUsage": [
- "string"
], - "keyUsage": [
- "string"
], - "subjectType": "endEntity",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "certificateContent": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "locations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- null
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
], - "sourceObjects": [
- null
]
}
]
}
]
}
], - "nonCompliantRules": [
- {
- "connectorName": "Provider1",
- "ruleName": "RuleName",
- "ruleDescription": "Description sample",
- "status": "ok",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "key": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": null,
- "name": null,
- "label": null,
- "type": null,
- "contentType": null,
- "content": [ ]
}
]
}
], - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "associations": 0
}, - "certificateRequest": {
- "certificateType": "X.509",
- "certificateRequestFormat": "pkcs10",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "content": "string",
- "commonName": "string",
- "subjectDn": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "keyUuid": "string"
}, - "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
- "issueAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "revokeAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "relatedCertificates": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
], - "protocolInfo": {
- "protocol": "acme",
- "protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
- "additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}
]
}| uuid required | string Certificate UUID |
| certificateFormat required | string (CertificateFormat) Enum: "raw" "pkcs7" Certificate format |
| withEndCertificate | boolean |
| encoding required | string (CertificateFormatEncoding) Enum: "pem" "der" |
{- "format": "raw",
- "encoding": "pem",
- "content": "string",
- "completeChain": true
}| uuid required | string Certificate UUID |
required | object (PaginationRequestDto) |
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "approvals": [
- {
- "approvalUuid": "string",
- "creatorUuid": "string",
- "creatorUsername": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiryAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "resource": "NONE",
- "resourceAction": "string",
- "objectUuid": "string",
- "approvalProfileName": "string",
- "approvalProfileUuid": "string"
}
]
}| certificateUuid required | string Certificate UUID |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": true,
- "supportMultipleEntries": "false",
- "supportKeyManagement": "false",
- "certificates": [
- {
- "certificateUuid": "string",
- "state": "requested",
- "validationStatus": "not_checked",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
], - "sourceObjects": [
- {
- "uuid": null,
- "name": null
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": "false"
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}
][- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
][- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true,
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}, - "intuneTenant": "string",
- "intuneApplicationId": "string"
}| uuid required | string SCEP Profile UUID |
| description | string Description of the SCEP Profile |
| raProfileUuid | string RA Profile UUID |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
| caCertificateUuid required | string UUID of the Certificate to be used as CA Certificate for SCEP Requests |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| renewalThreshold | integer <int32> Default: "Half of certificate validity" Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol |
| includeCaCertificate | boolean Default: "False" Include CA Certificate in the SCEP Message response |
| includeCaCertificateChain | boolean Default: "False" Include CA Certificate Chain in the SCEP Message response |
| challengePassword | string Challenge Password for the SCEP Request |
| enableIntune | boolean Status of Intune |
| intuneTenant | string Intune Tenant |
| intuneApplicationId | string Intune Application ID |
| intuneApplicationKey | string Intune Application Key |
{- "description": "Sample description",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "renewalThreshold": "Half of certificate validity",
- "includeCaCertificate": "False",
- "includeCaCertificateChain": "False",
- "challengePassword": "string",
- "enableIntune": true,
- "intuneTenant": "string",
- "intuneApplicationId": "string",
- "intuneApplicationKey": "string"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true,
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}, - "intuneTenant": "string",
- "intuneApplicationId": "string"
}[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true
}
]| description | string Description of the SCEP Profile |
| raProfileUuid | string RA Profile UUID |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
| caCertificateUuid required | string UUID of the Certificate to be used as CA Certificate for SCEP Requests |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| renewalThreshold | integer <int32> Default: "Half of certificate validity" Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol |
| includeCaCertificate | boolean Default: "False" Include CA Certificate in the SCEP Message response |
| includeCaCertificateChain | boolean Default: "False" Include CA Certificate Chain in the SCEP Message response |
| challengePassword | string Challenge Password for the SCEP Request |
| enableIntune | boolean Status of Intune |
| intuneTenant | string Intune Tenant |
| intuneApplicationId | string Intune Application ID |
| intuneApplicationKey | string Intune Application Key |
| name required | string Name of the SCEP Profile |
{- "description": "Sample description",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "renewalThreshold": "Half of certificate validity",
- "includeCaCertificate": "False",
- "includeCaCertificateChain": "False",
- "challengePassword": "string",
- "enableIntune": true,
- "intuneTenant": "string",
- "intuneApplicationId": "string",
- "intuneApplicationKey": "string",
- "name": "Profile Name 1"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true,
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}, - "intuneTenant": "string",
- "intuneApplicationId": "string"
}SCEP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}SCEP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| intuneEnabled required | boolean flag to return certificates that are eligible for Intune integration |
[- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
]SCEP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]SCEP Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]| name required | string Name of the Compliance Profile |
| description | string Description of the Compliance Profile |
Array of objects (ComplianceProfileRulesRequestDto) Rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "Profile 1",
- "description": "Profile 1",
- "rules": [
- {
- "connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120005",
- "kind": "x509",
- "rules": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "groups": [
- "string"
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "string"
}Compliance Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]| uuid required | string Compliance Profile UUID |
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| ruleUuid required | string UUID of the rule |
Array of objects (RequestAttributeDto) Attributes for the rule |
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "Sample rule description",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "groupUuid": "string",
- "certificateType": "X.509",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "complianceProfileUuid": "string",
- "complianceProfileName": "string"
}| uuid required | string Compliance Profile UUID |
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| ruleUuid required | string UUID of the rule |
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}{- "message": "Error message"
}| uuid required | string Compliance Profile UUID |
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| groupUuid required | string UUID of the group |
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}{- "message": "Error message"
}| uuid required | string Compliance Profile UUID |
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| groupUuid required | string UUID of the group |
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}{- "message": "Error message"
}RA Profile UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| uuid required | string Compliance Profile UUID |
| raProfileUuids required | Array of strings List of UUIDs of RA Profiles to be associated |
{- "raProfileUuids": "[\"18324af0-e95c-11ec-8fea-0242ac120002\",\"18324c94-e95c-11ec-8fea-0242ac120002\""
}{- "message": "Error message"
}| uuid required | string Compliance Profile UUID |
| raProfileUuids required | Array of strings List of UUIDs of RA Profiles to be associated |
{- "raProfileUuids": "[\"18324af0-e95c-11ec-8fea-0242ac120002\",\"18324c94-e95c-11ec-8fea-0242ac120002\""
}{- "message": "Error message"
}| uuid required | string Compliance Profile UUID |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "rules": [
- {
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "rules": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "Sample rule description",
- "certificateType": "X.509",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
]
}
], - "groups": [
- {
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "Sample group description"
}
]
}
], - "raProfiles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| complianceProvider | string |
| kind | string |
| certificateType | Array of strings (CertificateType) Items Enum: "X.509" "SSH" |
[- {
- "connectorName": "Provider1",
- "connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
- "kind": "Kind1",
- "rules": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Rule1",
- "certificateType": "X.509",
- "attributes": [
- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- null
], - "value": { }
}
]
}
}
], - "description": "Sample rule description"
}
]
}
][- {
- "connectorName": "Provider1",
- "connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
- "kind": "Kind1",
- "groups": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "RFC",
- "description": "Sample description of the group"
}
]
}
][- "string"
][- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| uuid required | string Token Instance UUID |
| name required | string Name of the Token Instance |
| description | string Token Instance description |
| connectorUuid required | string UUID of the Connector |
| kind required | string Connector Kind |
required | Array of objects (RequestAttributeDto) Custom Attributes |
required | Array of objects (RequestAttributeDto) Attributes for Token Instance |
{- "name": "string",
- "description": "string",
- "connectorUuid": "string",
- "kind": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| name required | string Name of the Token Instance |
| description | string Token Instance description |
| connectorUuid required | string UUID of the Connector |
| kind required | string Connector Kind |
required | Array of objects (RequestAttributeDto) Custom Attributes |
required | Array of objects (RequestAttributeDto) Attributes for Token Instance |
{- "name": "string",
- "description": "string",
- "connectorUuid": "string",
- "kind": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| uuid required | string Token Instance UUID |
| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
][- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]Token Instance UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
required | Array of objects (RequestAttributeDto) List of signature Attributes |
required | Array of objects (SignatureRequestData) Data to be signed |
required | Array of objects (SignatureRequestData) Signatures to verify |
{- "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "data": [
- {
- "data": "string",
- "identifier": "customId"
}
], - "signatures": [
- {
- "data": "string",
- "identifier": "customId"
}
]
}{- "verifications": [
- {
- "result": true,
- "identifier": "customId",
- "details": { }
}
]
}| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
required | Array of objects (RequestAttributeDto) List of signature Attributes |
required | Array of objects (SignatureRequestData) Data to be signed |
{- "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "data": [
- {
- "data": "string",
- "identifier": "customId"
}
]
}{- "signatures": [
- {
- "data": "string",
- "identifier": "customId",
- "details": { }
}
]
}| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
required | Array of objects (RequestAttributeDto) List of cipher Attributes |
required | Array of objects (CipherRequestData) Encrypted/decrypted data |
{- "cipherAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "cipherData": [
- {
- "data": "string",
- "identifier": "customId"
}
]
}{- "encryptedData": [
- {
- "data": "string",
- "identifier": "customId",
- "details": { }
}
]
}| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
required | Array of objects (RequestAttributeDto) List of cipher Attributes |
required | Array of objects (CipherRequestData) Encrypted/decrypted data |
{- "cipherAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "cipherData": [
- {
- "data": "string",
- "identifier": "customId"
}
]
}{- "decryptedData": [
- {
- "data": "string",
- "identifier": "customId",
- "details": { }
}
]
}| tokenInstanceUuid required | string Token Instance UUID |
| length required | integer <int32> Number of random bytes to generate |
Array of objects (RequestAttributeDto) Random generator Attributes |
{- "length": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "data": "string"
}| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| uuid required | string Key instance UUID |
| keyItemUuid required | string Key Item UUID |
| algorithm required | string (KeyAlgorithm) Enum: "RSA" "ECDSA" "FALCON" "CRYSTALS-Dilithium" "SPHINCS+" "Unknown" Cryptographic algorithm |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
| algorithm required | string (KeyAlgorithm) Enum: "RSA" "ECDSA" "FALCON" "CRYSTALS-Dilithium" "SPHINCS+" "Unknown" Cryptographic algorithm |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| tokenInstanceUuid required | string Token Instance UUID |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "conditions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}
]
}| ruleUuid required | string Rule UUID |
| description | string Description of the Rule |
| conditionsUuids required | Array of strings List of UUIDs of existing conditions to add to the rule |
{- "description": "string",
- "conditionsUuids": [
- "string"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "conditions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}| conditionUuid required | string Condition UUID |
| description | string Description of the condition |
required | Array of objects (ConditionItemRequestDto) List of the condition items to add to condition |
{- "description": "string",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}| resource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE"
}
]| name required | string Name of the rule |
| description | string Description of the rule |
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the rule |
| conditionsUuids required | Array of strings List of UUIDs of existing conditions to add to the rule |
{- "name": "string",
- "description": "string",
- "resource": "NONE",
- "conditionsUuids": [
- "string"
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "resource": "NONE",
- "conditions": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}
]
}| resource | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}
]| name required | string Name of the condition |
| description | string Description of the condition |
| type required | string (ConditionType) Value: "checkField" Type of the condition |
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the condition |
required | Array of objects (ConditionItemRequestDto) List of the condition items to add to condition |
{- "name": "string",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "checkField",
- "resource": "NONE",
- "items": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "operator": "EQUALS",
- "value": { }
}
]
}{- "property1": {
- "property1": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}, - "property2": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}
}, - "property2": {
- "property1": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}, - "property2": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}
}
}| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}| uuid required | string UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" Content Type of the Attribute |
required | Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute |
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]{- "message": "Error message"
}[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
][- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
][- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
][- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]If the request body provided, only those key items will be updated. If the request body is not provided or given empty, then the entire key will be updated
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Key UUID |
| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
| uuids | Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key |
{- "usage": [
- "sign"
], - "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "keyData": "string",
- "length": 0,
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active",
- "reason": "disclosure"
}
], - "associations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "resource": "NONE"
}
]
}| uuid required | string Key UUID |
| tokenProfileUuid | string UUID of the token profile |
| name required | string Name of the Cryptographic Key |
| description required | string Description of the Cryptographic Key |
| ownerUuid | string Key Owner UUID |
| groupUuids | Array of strings UUIDs of the groups to associate with key |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "tokenProfileUuid": "string",
- "name": "string",
- "description": "string",
- "ownerUuid": "string",
- "groupUuids": [
- "string"
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "keyData": "string",
- "length": 0,
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active",
- "reason": "disclosure"
}
], - "associations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "resource": "NONE"
}
]
}If the request body provided, only those key items will be deleted. If the request body is not provided or given empty, then the entire key will be destroyed
| uuid required | string Key UUID |
Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body provided, only those key items will be updated. If the request body is not provided or given empty, then the entire key will be updated
| uuid required | string Key UUID |
| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
| uuids | Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key |
{- "usage": [
- "sign"
], - "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}Update the key usages for multiple keys and all the items inside it
| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
| uuids required | Array of strings <uuid> [ items <uuid > ] Key UUIDs |
{- "usage": [
- "sign"
], - "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}Update the key usages for multiple keys Items
| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
| uuids required | Array of strings <uuid> [ items <uuid > ] Key Item UUIDs |
{- "usage": [
- "sign"
], - "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}| tokenInstanceUuid required | string UUID of the Token Instance |
| tokenProfileUuid required | string UUID of the Token Profile |
| type required | string (KeyRequestType) Enum: "secret" "keyPair" Type of the key to be created |
| name required | string Name of the Cryptographic Key |
| description required | string Description of the Cryptographic Key |
| groupUuids | Array of strings UUIDs of the groups to associate with key |
required | Array of objects (RequestAttributeDto) List of Attributes to create a Key |
Array of objects (RequestAttributeDto) Custom Attributes for the key | |
| enabled | boolean Default: "false" Enabled status of created key. True = Enabled, False = Disabled |
{- "name": "string",
- "description": "string",
- "groupUuids": [
- "string"
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "enabled": "false"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "keyData": "string",
- "length": 0,
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active",
- "reason": "disclosure"
}
], - "associations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "resource": "NONE"
}
]
}Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}{- "cryptographicKeys": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}Key UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body provided, only those key items will be enabled. If the request body is not provided or given empty, then the entire key will be enabled
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Key UUID |
Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body provided, only those key items will be disabled. If the request body is not provided or given empty, then the entire key will be disabled
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Key UUID |
Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body provided, only those key items will be destroyed. If the request body is not provided or given empty, then the entire key will be destroyed
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Key UUID |
Key UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body is provided with the UUID of the items of Key, then only those itemswill be compromised. Else all the sub items of the key will be compromised
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Key UUID |
| reason required | string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key |
| uuids | Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key |
{- "reason": "disclosure",
- "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}| uuid required | string UUID of the Key |
| keyItemUuid required | string UUID of the Key Item |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "keyData": "string",
- "length": 0,
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active",
- "reason": "disclosure"
}| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
| name required | string Name of the key item |
{- "name": "string"
}[ "Error Message 1", "Error Message 2" ]
If the request body provided, only those key items will be enabled. If the request body is not provided or given empty, then the entire key will be enabled
| uuid required | string Key UUID |
Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body provided, only those key items will be disabled. If the request body is not provided or given empty, then the entire key will be disabled
| uuid required | string Key UUID |
Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body provided, only those key items will be destroyed. If the request body is not provided or given empty, then the entire key will be destroyed
| uuid required | string Key UUID |
Key UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}If the request body is provided with the UUID of the items of Key, then only those itemswill be compromised. Else all the sub items of the key will be compromised
| uuid required | string Key UUID |
| reason required | string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key |
| uuids | Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key |
{- "reason": "disclosure",
- "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}This API can be used to mark multiple keys items to be marked as compromised.
| reason required | string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key |
| uuids | Array of strings <uuid> [ items <uuid > ] List of Key Item UUID |
{- "reason": "disclosure",
- "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}Key UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}This API can be used to mark multiple keys and its sub items to be marked as compromised.Specific part of the key cannot be mentioned in this API
| reason required | string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key |
| uuids | Array of strings <uuid> [ items <uuid > ] List of UUIDs of the keys. This will mark all the items inside the selected key as compromised |
{- "reason": "disclosure",
- "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "message": "Error message"
}| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
| type required | string (KeyRequestType) Enum: "secret" "keyPair" Type of the key to be created |
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]| tokenInstanceUuid required | string UUID of the Token Instance |
| uuid required | string UUID of the Key |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "keyData": "string",
- "length": 0,
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active",
- "reason": "disclosure"
}
], - "associations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "resource": "NONE"
}
]
}If the request body provided, only those key items will be deleted. If the request body is not provided or given empty, then the entire key will be destroyed
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Key UUID |
Key Item UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| tokenInstanceUuid required | string UUID of the Token Instance |
| uuid required | string UUID of the Key |
| keyItemUuid required | string UUID of the Key Item |
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "keyData": "string",
- "length": 0,
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active",
- "reason": "disclosure"
}| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
[- {
- "uuid": "string",
- "keyUuid": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "event": "Create Key",
- "status": "SUCCESS",
- "message": "string",
- "additionalInformation": {
- "property1": { },
- "property2": { }
}
}
]| uuid required | string Key UUID |
| keyItemUuid required | string Key Item UUID |
[- {
- "uuid": "string",
- "keyUuid": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "event": "Create Key",
- "status": "SUCCESS",
- "message": "string",
- "additionalInformation": {
- "property1": { },
- "property2": { }
}
}
][- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]This API contains the logic to get the keys that contains the full key pair (private and public Key)
| tokenProfileUuid | string |
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "ownerUuid": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
]
}
]
}
], - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret",
- "keyAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "associations": 0
}
]Key Items UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "message": "Error message"
}| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource |
| settable | boolean |
[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource |
[- {
- "event": "discoveryFinished",
- "producedResource": "NONE"
}
]| name required | string Name of the Connector |
| url required | string URL of the Connector to connect |
| authType required | string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector |
Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "Connector1",
- "authType": "none",
- "authAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "string"
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true,
- "users": [
- {
- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| roleUuid required | string Role UUID |
| name | string Name of the role |
| description | string Description for the role |
string Role contact email | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "string",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true,
- "users": [
- {
- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| roleUuid required | string Role UUID |
| resourceUuid required | string Resource UUID |
| objectUuid required | string Object UUID |
| uuid required | string UUID of the Object |
| name required | string Name of the Object |
| allow | Array of strings Allowed Action list |
| deny | Array of strings Denied Action list |
{- "uuid": "string",
- "name": "string",
- "allow": [
- "string"
], - "deny": [
- "string"
]
}{- "message": "Error message"
}| name | string Name of the role |
| description | string Description for the role |
string Role contact email | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
{- "name": "string",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true,
- "users": [
- {
- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}{- "allowAllResources": true,
- "resources": [
- {
- "name": "string",
- "allowAllActions": true,
- "actions": [
- "string"
], - "objects": [
- {
- "uuid": "string",
- "name": "string",
- "allow": [
- "string"
], - "deny": [
- "string"
]
}
]
}
]
}| roleUuid required | string Role UUID |
| allowAllResources required | boolean Allow all resources, True = Yes, False = No |
Array of objects (ResourcePermissionsRequestDto) Resources |
{- "allowAllResources": true,
- "resources": [
- {
- "name": "string",
- "allowAllActions": true,
- "actions": [
- "string"
], - "objects": [
- {
- "uuid": "string",
- "name": "string",
- "allow": [
- "string"
], - "deny": [
- "string"
]
}
]
}
]
}{- "allowAllResources": true,
- "resources": [
- {
- "name": "string",
- "allowAllActions": true,
- "actions": [
- "string"
], - "objects": [
- {
- "uuid": "string",
- "name": "string",
- "allow": [
- "string"
], - "deny": [
- "string"
]
}
]
}
]
}| roleUuid required | string Role UUID |
| resourceUuid required | string Resource UUID |
| uuid required | string UUID of the Object |
| name required | string Name of the Object |
| allow | Array of strings Allowed Action list |
| deny | Array of strings Denied Action list |
[- {
- "uuid": "string",
- "name": "string",
- "allow": [
- "string"
], - "deny": [
- "string"
]
}
]{- "message": "Error message"
}[- {
- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true
}
]| roleUuid required | string Role UUID |
User UUIDs
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true,
- "users": [
- {
- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}| roleUuid required | string Role UUID |
| resourceUuid required | string Resource UUID |
{- "name": "string",
- "allowAllActions": true,
- "actions": [
- "string"
], - "objects": [
- {
- "uuid": "string",
- "name": "string",
- "allow": [
- "string"
], - "deny": [
- "string"
]
}
]
}{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "approvals": [
- {
- "approvalUuid": "string",
- "creatorUuid": "string",
- "creatorUsername": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiryAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "resource": "NONE",
- "resourceAction": "string",
- "objectUuid": "string",
- "approvalProfileName": "string",
- "approvalProfileUuid": "string"
}
]
}{- "approvalUuid": "string",
- "creatorUuid": "string",
- "creatorUsername": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiryAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "resource": "NONE",
- "resourceAction": "string",
- "objectUuid": "string",
- "approvalProfileName": "string",
- "approvalProfileUuid": "string",
- "expiry": 0,
- "description": "string",
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "username": "string",
- "roleName": "string",
- "groupName": "string",
- "approvalStepRecipients": [
- {
- "approvalRecipientUuid": "string",
- "userUuid": "string",
- "username": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "comment": "string"
}
]
}
]
}required | object (PaginationRequestDto) |
required | object (ApprovalUserDto) Select if you want to list all history of approvals by user |
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "approvals": [
- {
- "approvalUuid": "string",
- "creatorUuid": "string",
- "creatorUsername": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiryAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "resource": "NONE",
- "resourceAction": "string",
- "objectUuid": "string",
- "approvalProfileName": "string",
- "approvalProfileUuid": "string"
}
]
}